Paramètres
Il est possible d'accéder aux données au moyen d’une série de paramètres permettant de spécifier les observations qui doivent être retournées par la requête. Un paramètre peut être un indicateur, une variable catégorielle ou un filtre. Un indicateur renvoie une valeur d’indicateur pour le type d’indicateur spécifié. Une variable catégorielle renvoie les valeurs de l’indicateur au niveau d'agrégation spécifié. Un filtre limitera les résultats en fonction des valeurs du filtre.
Lors de l’interrogation de l’API, l’utilisateur spécifie des paramètres via des chaînes de requête vers l’URL de l’API :
Tableau des paramètres
Le tableau suivant met en évidence les paramètres obligatoires et facultatifs qui peuvent être envoyés à l’API pour chaque catégorie d’indicateur (voir la documentation sur les indicateurs) sous forme de requêtes de chaînes. La colonne « Paramètre » correspond à la syntaxe exacte requise par l’API égale à la syntaxe décrite dans la colonne « Valeurs acceptées ». Notez que lorsqu’un enregistrement de tableau est « n/a », le paramètre n’est pas utilisé pour la catégorie d’indicateur donnée. De plus, si la requête API dépasse la date maximale, l’API retournera les données les plus récentes disponibles.
| Parameter | Description | Obligatoire ou facultatif | Valeurs acceptées — Indicateurs standard | Valeurs acceptées — Offres d’emploi | Valeurs acceptées — Exigences de travail | Valeur par défaut |
|---|---|---|---|---|---|---|
| indicator | Sélectionne les valeurs d’intérêt dans le carrefour de données | Obligatoire | 1-14 | 14-16 | 17-18 | Aucune – doit être fournie explicitement |
| index_date | Date de l'intégration des données. | Facultatif | YYYYMMDD | YYYYMMDD | YYYYMMDD | Date maximale |
| start | Période de début d’intérêt | Obligatoire | YYYYMMDD | YYYYMMDD | YYYYMMDD | Date maximale |
| end | Fin de la période d’intérêt. | Obligatoire | YYYYMMDD | YYYYMMDD | YYYYMMDD | Date maximale |
| freq | Fréquence des données rapportées. | Facultatif | “monthly” | “monthly”, “annual”, “quarterly” | “monthly”, “annual”, “quarterly” | “monthly” |
| geo | Niveau géographique des données rapportées. | Facultatif | “canada”, "economic_regions", "provinces_territories", "cma" | “canada”, "economic_regions", "provinces_territories", "cma", "location", "census_division" | “canada”, "economic_regions", "provinces_territories", "cma", "location", "census_division" | “canada” |
| sex | Sexes disponibles des données rapportées. | Facultatif | “both sexes”, “male”, “female” | n/a | n/a | “both sexes” |
| age | Âges des données rapportées. | Facultatif | “15+”, “15–24”, “25–54”, “55+” | n/a | n/a | “15+” |
| seasonality | Si les données sont désaisonnalisées. | Facultatif | “unadjusted”, “seasonally adjusted”, “trend cycle” | n/a | n/a | “unadjusted” |
| lang | Retourner les valeurs en français ou en anglais. | Facultatif | “fr”, “en” | “fr”, “en” | “fr”, “en” | “en” |
| noc_level | Niveau du code national des professions* | Facultatif | 1–4; 0; -1; -0 | 1–4; 0; -1; -1 | 1–4; 0; -1; -2 | NULL |
| naics_level | Système de classification des industries de l’Amérique du Nord* | Facultatif | 2–4; 0; -1; -0 | n/a | n/a | NULL |
| work_requirement | Une exigence de travail définie par Vicinity Jobs. | Facultatif | n/a | n/a | "Data analysis", "Attention to detail" | NULL |
| page | Index de pagination des réponses. | Facultatif | > 0 et < valeur « total_pages » retournée dans les données utiles | > 0 et < valeur « total_pages » retournée dans les données utiles | > 0 et < valeur « total_pages » retournée dans les données utiles | 1 |
Détails des paramètres
L’indicateur est un indicateur d’information sur le marché du travail qui est requis pour chaque requête API. Il y en a 18 actuellement.
index_date
La date d’intégration dans le Carrefour de données pour chaque enregistrement.
start and end
La période qui nous intéresse. La date de début et de fin doivent être utilisés ensemble ou pas du tout dans une requête donnée. Si les dates de début et de fin ne sont pas utilisées, les dates retournées par le Carrefour de données sont arbitraires. Tous les mois compris entre les dates de début et de fin spécifiées seront renvoyés sous forme de mois - l’agrégation par défaut. De plus, par souci de clarté, lorsque vous utilisez des indicateurs qui mesurent la croissance d’une année à l’autre ou d’un mois à l’autre, la comparaison se fait entre les mois inclus dans les dates du début à la fin et les mois/années antérieurs respectifs.
freq
Le paramètre de fréquence peut être utilisé pour spécifier des agrégations annuelles et trimestrielles au lieu de l'agrégation mensuelle par défaut. Certains indicateurs ne peuvent être agrégés que mensuellement - l’API renverra une réponse vide pour ces indicateurs (veuillez attendre la documentation complémentaire pour plus de détails à ce sujet).
geo
Le Carrefour de données dispose de plusieurs options d’agrégation géographique. L’agrégation la plus courante est celle par provinces et territoires, qui est disponible pour tous les indicateurs. Les agrégations des divisions de recensement ne sont disponibles que pour les indicateurs Offres d'emploi et Exigences de travail. Des filtres peuvent être appliqués au corps de la requête API pour isoler des lieux précis.
sex
Le Carrefour de données permet l’agrégation par les deux sexes, hommes et femmes, pour la plupart des données reçues de Statistique Canada.
age
Pour les indicateurs disponibles, l’âge peut être sélectionné.
seasonality
Le Carrefour de données comporte certains indicateurs qui peuvent être ajustés en fonction de la saisonnalité, ce qui permet de lisser les données mensuelles en tenant compte du caractère cyclique de secteurs comme l’agriculture.
lang
Les requêtes API doivent être rédigées en anglais. La réponse API est en anglais par défaut, mais peut être modifiée en français en utilisant «fr», le paramètre de langue.
noc_level
Ce paramètre regroupe la réponse API par niveau de CNP de 1 à 4 chiffres et est disponible pour tous les indicateurs. Le premier niveau correspond à des les descriptions professionnelles généralisées, et le quatrième est le plus granulaire. Des filtres peuvent être appliqués au corps de la requête API pour filtrer certaines CNP. Assurez-vous que toute CNP filtrée correspond au niveau de CNP sélectionné comme paramètre.
naics_level
Comme pour le paramètre noc_level, le niveau de description de la profession peut être agrégé. Des filtres peuvent être appliqués au corps de la requête API pour isoler certains codes SCIAN. Veuillez noter que les niveaux SCIAN du Carrefour de données diffèrent légèrement des niveaux SCIAN de Statistique Canada. Le niveau SCIAN du Carrefour de données correspond au nombre de chiffres du code SCIAN, tandis que le niveau SCIAN de Statistique Canada fait partie de la structure hiérarchique du SCIAN. Cette logique est identique à celle des niveaux CNP, où un niveau CNP dans le Carrefour de données correspond au nombre de chiffres du code CNP.
work_requirement
La proportion dans laquelle une exigence professionnelle donnée est observée dans un groupe sélectionné d'offres d'emploi. Par exemple, il s'agit de trouver la proportion d'offres d'emploi dans le domaine des affaires, de la finance et de l'administration (code CNP 1) qui mentionnent la "gestion des risques" comme exigence. L'API renverra une valeur entre 0 et 1 (0-100 %).
page
Page de réponse à afficher. La pagination est requise pour les réponses dépassant la limite d’une page de 1000 enregistrements.